home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 11 / spelldoc.zip / SPELL.TXT < prev   
Text File  |  1987-07-23  |  4KB  |  133 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.               Using MicroSPELL 1.0
  7.             Author:  Brian Straight
  8.  
  9.  
  10. Introduction
  11.  
  12. MicroSPELL  1.0  is  a compact, efficient, fast spelling checker for use
  13. both as a stand alone program, and with  MicroEMACS  v3.9  and    above on
  14. many  different  computers.   This document briefly describes how to use
  15. MicroSPELL.
  16.  
  17. Command Syntax
  18.  
  19. spell {<options>} <file> {<file>.........<file>}
  20.  
  21. The currently available options are:
  22.  
  23. -d        debugging mode
  24. -e        use MicroEMACS to scan errors
  25. -u <fname>    use a user word list
  26. -w        output a word list instead of a location list
  27.  
  28. Example
  29.  
  30.     Let's assume that  you    want  to  spell check a text file called
  31. text.txt which is on the B drive of your machine.  To invoke spell type:
  32.  
  33. spell -e b:text.txt
  34.  
  35.     Be  patient.    It will take SPELL a short while to complete its
  36. setup procedure.  If would like to know more about  what  SPELL is doing
  37. at this point,    you  can  set  the  debugging switch (-d} when you first
  38. invoke the program.  SPELL will then give you detailed information about
  39. what it is doing.
  40.  
  41.     When SPELL  has finished checking your file against its internal
  42. dictionary, it will give you a brief report of how many suspect words it
  43. found, and then, since we used the -e switch, it will  invoke MicroEMACS
  44. in order to scan through the suspect words.  Notice  that  the screen is
  45. very like the standard MicroEMACS screen, except that  the  function key
  46. window (if it is normally there) is now replaced by the  SPELL functions
  47. and status window.
  48.  
  49.     There are a number of elements in this function window    that you
  50. need to be aware of.  On the top line, the "File" field lists which file
  51. the  scan is currently on.  This is useful when many different files are
  52. spell checked  together  in  one  run (many file names can be put on the
  53. command line at once).    The  first  number  is the current file, and the
  54. second number is the total number of files.
  55.  
  56.     The second  field  on  the  top  line  is the "Word" filed. This
  57. describes the current suspect word and the total number of suspect words
  58. in  the current file.  This will give you an idea of how far  throughout
  59. the file you have progressed during the scan.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.     One at a time, each suspect word in the file is presented to you
  73. for  you  to  decide on its disposition.  The suspect word is displayed,
  74. and the question "Option:" appears in the Dialog Window.    The  options
  75. you have include:
  76.  
  77. (S)kip        Skip this word, leaving it alone, and go on to the next.
  78.  
  79. (I)gnore    Ignore this word and all other occurences of this word
  80.         during this scan.
  81.  
  82. (C)hange    Change this word.  You will be asked to type a
  83.         replacement word.  This word will replace the original
  84.         and MicroEMACS will remember the replacement.
  85.  
  86. (D)efault    If you have already replaced an identical occurance
  87.    replace    of this suspect word, MicroEMACS will present the last
  88.         replacement as a "Default Replacement".  Picking this
  89.         option automatically replaces the suspect word with
  90.         this default word.
  91.  
  92. (G)lobal    When you first encounter a suspect word, if you wish
  93.     change    it to be replaced in the entire document, use this
  94.         option. You will be prompted for the replacement word.
  95.  
  96. (A)dd word    To a user dictionary.  This word will then be remembered
  97.         for the remander of the current scan, and also for all
  98.         future scans when that user dictionary is invoked.
  99.  
  100. (U)pper case    Add a word to a user dictionary in its current case.
  101.         This is good for names, proper nouns and acronyms.
  102.  
  103. (Q)uit        Finish the current scan, saving the file with the
  104.         already completed changes.
  105.  
  106. Note: Scanning document files will be availible on the    IBM  370  series
  107. under the CMS operating system in September 1987 using an XEDIT script.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                   - 2 -
  130.  
  131.  
  132.  
  133.